package com.xy.webadmin.app.service;

import com.xy.webadmin.app.model.*;
import com.xy.common.core.object.CallResult;
import com.xy.common.core.base.service.IBaseService;

import java.util.*;

/**
 * 学生数据操作服务接口。
 *
 * @author xiaoyue
 * @date 2025-05-13
 */
public interface StudentService extends IBaseService<Student, Long> {

    /**
     * 保存新增对象。
     *
     * @param student 新增对象。
     * @return 返回新增对象。
     */
    Student saveNew(Student student);

    /**
     * 利用数据库的insertList语法，批量插入对象列表。
     *
     * @param studentList 新增对象列表。
     */
    void saveNewBatch(List<Student> studentList);

    /**
     * 批量插入或更新数据，同时还会根据指定列的数据是否存在进行校验，如果存在则更新，否则批量新增。
     *
     * @param studentList 数据列表。
     * @param duplicateVerifyColumns 判断指定列的数据是否存在。
     * @param batchSize 每个小批次的数量，小于等于0时将使用默认值。
     */
    void saveNewOrUpdateBatch(List<Student> studentList, List<String> duplicateVerifyColumns, int batchSize);

    /**
     * 更新数据对象。
     *
     * @param student         更新的对象。
     * @param originalStudent 原有数据对象。
     * @return 成功返回true，否则false。
     */
    boolean update(Student student, Student originalStudent);

    /**
     * 删除指定数据。
     *
     * @param id 主键Id。
     * @return 成功返回true，否则false。
     */
    boolean remove(Long id);

    /**
     * 获取单表查询结果。由于没有关联数据查询，因此在仅仅获取单表数据的场景下，效率更高。
     * 如果需要同时获取关联数据，请移步(getStudentListWithRelation)方法。
     *
     * @param filter  过滤对象。
     * @param orderBy 排序参数。
     * @return 查询结果集。
     */
    List<Student> getStudentList(Student filter, String orderBy);

    /**
     * 获取主表的查询结果，以及主表关联的字典数据和一对一从表数据，以及一对一从表的字典数据。
     * 该查询会涉及到一对一从表的关联过滤，或一对多从表的嵌套关联过滤，因此性能不如单表过滤。
     * 如果仅仅需要获取主表数据，请移步(getStudentList)，以便获取更好的查询性能。
     *
     * @param filter 主表过滤对象。
     * @param orderBy 排序参数。
     * @return 查询结果集。
     */
    List<Student> getStudentListWithRelation(Student filter, String orderBy);

    /**
     * 在多对多关系中，当前Service的数据表为从表，返回不与指定主表主键Id存在对多对关系的列表。
     *
     * @param clazzId 主表主键Id。
     * @param filter 从表的过滤对象。
     * @param orderBy 排序参数。
     * @return 查询结果集。
     */
    List<Student> getNotInStudentListByClazzId(Long clazzId, Student filter, String orderBy);

    /**
     * 在多对多关系中，当前Service的数据表为从表，返回与指定主表主键Id存在对多对关系的列表。
     *
     * @param clazzId 主表主键Id。
     * @param filter 从表的过滤对象。
     * @param studentClazzFilter 多对多关联表过滤对象。
     * @param orderBy 排序参数。
     * @return 查询结果集。
     */
    List<Student> getStudentListByClazzId(
            Long clazzId, Student filter, StudentClazz studentClazzFilter, String orderBy);

    /**
     * 在多对多关系中，当前Service的数据表为从表，返回与指定主表主键Id列表存在对多对关系的列表。
     *
     * @param clazzList 主表对象集合。
     * @param filter 从表的过滤对象。
     * @param orderBy 排序参数。
     * @return key是主表的主键Id，value是多对多从表的对象列表。
     */
    Map<Long, List<Student>> getStudentListMapByClazzList(
            List<Clazz> clazzList, Student filter, String orderBy);

    /**
     * 在多对多关系中，当前Service的数据表为从表，返回不与指定主表主键Id存在对多对关系的列表。
     *
     * @param guardianId 主表主键Id。
     * @param filter 从表的过滤对象。
     * @param orderBy 排序参数。
     * @return 查询结果集。
     */
    List<Student> getNotInStudentListByGuardianId(Long guardianId, Student filter, String orderBy);

    /**
     * 在多对多关系中，当前Service的数据表为从表，返回与指定主表主键Id存在对多对关系的列表。
     *
     * @param guardianId 主表主键Id。
     * @param filter 从表的过滤对象。
     * @param studentGuardianFilter 多对多关联表过滤对象。
     * @param orderBy 排序参数。
     * @return 查询结果集。
     */
    List<Student> getStudentListByGuardianId(
            Long guardianId, Student filter, StudentGuardian studentGuardianFilter, String orderBy);

    /**
     * 在多对多关系中，当前Service的数据表为从表，返回与指定主表主键Id列表存在对多对关系的列表。
     *
     * @param guardianList 主表对象集合。
     * @param filter 从表的过滤对象。
     * @param orderBy 排序参数。
     * @return key是主表的主键Id，value是多对多从表的对象列表。
     */
    Map<Long, List<Student>> getStudentListMapByGuardianList(
            List<Guardian> guardianList, Student filter, String orderBy);

    /**
     * 批量添加多对多关联关系。
     *
     * @param studentClazzList 多对多关联表对象集合。
     * @param studentId 主表Id。
     */
    void addStudentClazzList(List<StudentClazz> studentClazzList, Long studentId);

    /**
     * 更新中间表数据。
     *
     * @param studentClazz 中间表对象。
     * @return 更新成功与否。
     */
    boolean updateStudentClazz(StudentClazz studentClazz);

    /**
     * 获取中间表数据。
     *
     * @param studentId 主表Id。
     * @param clazzId 从表Id。
     * @return 中间表对象。
     */
    StudentClazz getStudentClazz(Long studentId, Long clazzId);

    /**
     * 移除单条多对多关系。
     *
     * @param studentId 主表Id。
     * @param clazzId 从表Id。
     * @return 成功返回true，否则false。
     */
    boolean removeStudentClazz(Long studentId, Long clazzId);

    /**
     * 批量移除单条多对多关系。
     *
     * @param studentId 主表Id。
     * @param clazzIdList 从表Id列表。
     */
    void removeStudentClazzList(Long studentId, List<Long> clazzIdList);

    /**
     * 批量添加多对多关联关系。
     *
     * @param studentGuardianList 多对多关联表对象集合。
     * @param studentId 主表Id。
     */
    void addStudentGuardianList(List<StudentGuardian> studentGuardianList, Long studentId);

    /**
     * 更新中间表数据。
     *
     * @param studentGuardian 中间表对象。
     * @return 更新成功与否。
     */
    boolean updateStudentGuardian(StudentGuardian studentGuardian);

    /**
     * 获取中间表数据。
     *
     * @param studentId 主表Id。
     * @param guardianId 从表Id。
     * @return 中间表对象。
     */
    StudentGuardian getStudentGuardian(Long studentId, Long guardianId);

    /**
     * 移除单条多对多关系。
     *
     * @param studentId 主表Id。
     * @param guardianId 从表Id。
     * @return 成功返回true，否则false。
     */
    boolean removeStudentGuardian(Long studentId, Long guardianId);

    /**
     * 批量移除单条多对多关系。
     *
     * @param studentId 主表Id。
     * @param guardianIdList 从表Id列表。
     */
    void removeStudentGuardianList(Long studentId, List<Long> guardianIdList);

    /**
     * 对批量导入数据列表进行数据合法性验证。
     * 验证逻辑主要覆盖主表的常量字典字段、字典表字典字段、数据源字段和一对一关联数据是否存在。
     *
     * @param dataList 主表的数据列表。
     * @param ignoreFieldSet 需要忽略校验的字典字段集合。通常对于字典反向翻译过来的字段适用，
     *                       避免了二次验证，以提升效率。
     * @return 验证结果。如果失败，包含具体的错误信息和导致错误的数据对象。
     */
    CallResult verifyImportList(List<Student> dataList, Set<String> ignoreFieldSet);
}
